Skip to main content
Version: 24.08

Search business partner by external ID. An empty external ID list returns a paginated list of all business partners.​

Get page of business partners filtered by a collection of external IDs.

Query Parameters
  • page string

    Default value: 0

    Number of page to get results from

  • size string

    Possible values: <= 100

    Default value: 10

    Size of each page

Request Body array
  • string
Responses

The requested page of busines partners

Schema
  • totalElements int64

    Total number of all results in all pages

  • totalPages int32

    Total number pages

  • page int32

    Current page number

  • contentSize int32

    Number of results in the page

  • content object[]

    Collection of results in the page

  • externalId string

    The identifier which uniquely identifies (in the internal system landscape of the sharing member) the business partner.

  • nameParts string[]

    The list of name parts to accommodate the different number of name fields in different systems.

  • identifiers object[]

    The list of identifiers of the business partner. Sorted and duplicates removed by the service.

  • type string

    The type of the identifier.

  • value string

    The value of the identifier like “DE123465789.

  • issuingBody string

    The name of the official register, where the identifier is registered. For example, a Handelsregisternummer in Germany is only valid with its corresponding Registergericht and Registerart.

  • states object[]

    The list of (temporary) states of the business partner. Sorted and duplicates removed by the service.

  • validFrom date-time

    Date since when the status is/was valid.

  • validTo date-time

    Date until the status was valid, if applicable.

  • type string

    Possible values: [ACTIVE, INACTIVE]

    The type of this specified status.

  • roles string[]

    Possible values: [SUPPLIER, CUSTOMER, ONE_TIME_SUPPLIER, ONE_TIME_CUSTOMER]

    One or more of the roles, the business partner assumes with respect to the sharing member: Supplier, Customer. Sorted and duplicates removed by the service.

  • isOwnCompanyData boolean

    Indicates whether the sharing member claims (in the initial upload) the business partner to belong to the company data of the sharing member.

  • legalEntity object

    The legal entity, on which the business partner provides a view.

  • legalEntityBpn string

    The BPNL of the legal entity, on which the business partner provides a view.

  • legalName string

    The name of the legal entity, on which the business partner provides a view, according to official registers.

  • shortName string

    The abbreviated name of the legal entity, on which the business partner provides a view.

  • legalForm string

    The legal form of the legal entity, on which the business partner provides a view.

  • states object[]
  • validFrom date-time

    Date since when the status is/was valid.

  • validTo date-time

    Date until the status was valid, if applicable.

  • type string

    Possible values: [ACTIVE, INACTIVE]

    The type of this specified status.

  • site object

    The site, on which the business partner provides a view.

  • siteBpn string

    The BPNS of the site, on which the business partner provides a view.

  • name string

    The name of the site, on which the business partner provides a view. This is not according to official registers but according to the name the owner chooses.

  • states object[]
  • validFrom date-time

    Date since when the status is/was valid.

  • validTo date-time

    Date until the status was valid, if applicable.

  • type string

    Possible values: [ACTIVE, INACTIVE]

    The type of this specified status.

  • address object

    The address, on which the business partner provides a view.

  • addressBpn string

    The BPNA of the address, on which the business partner provides a view.

  • name string

    The name of the address, on which the business partner provides a view. This is not according to official registers but according to the name the sharing members agree on, such as the name of a gate or any other additional names that designate the address in common parlance.

  • addressType string

    Possible values: [LegalAndSiteMainAddress, LegalAddress, SiteMainAddress, AdditionalAddress]

    One of the address types: Legal Address, Site Main Address, Legal and Site Main Address, Additional Address.

  • physicalPostalAddress object

    A physical postal address describes the physical location of an office, warehouse, gate, etc.

  • geographicCoordinates object

    The exact location of the physical postal address in latitude, longitude, and altitude.

  • longitude float

    Longitude coordinate

  • latitude float

    Latitude coordinate

  • altitude float

    Altitude, if applicable

  • country string

    Possible values: [UNDEFINED, AC, AD, AE, AF, AG, AI, AL, AM, AN, AO, AQ, AR, AS, AT, AU, AW, AX, AZ, BA, BB, BD, BE, BF, BG, BH, BI, BJ, BL, BM, BN, BO, BQ, BR, BS, BT, BU, BV, BW, BY, BZ, CA, CC, CD, CF, CG, CH, CI, CK, CL, CM, CN, CO, CP, CR, CS, CU, CV, CW, CX, CY, CZ, DE, DG, DJ, DK, DM, DO, DZ, EA, EC, EE, EG, EH, ER, ES, ET, EU, EZ, FI, FJ, FK, FM, FO, FR, FX, GA, GB, GD, GE, GF, GG, GH, GI, GL, GM, GN, GP, GQ, GR, GS, GT, GU, GW, GY, HK, HM, HN, HR, HT, HU, IC, ID, IE, IL, IM, IN, IO, IQ, IR, IS, IT, JE, JM, JO, JP, KE, KG, KH, KI, KM, KN, KP, KR, KW, KY, KZ, LA, LB, LC, LI, LK, LR, LS, LT, LU, LV, LY, MA, MC, MD, ME, MF, MG, MH, MK, ML, MM, MN, MO, MP, MQ, MR, MS, MT, MU, MV, MW, MX, MY, MZ, NA, NC, NE, NF, NG, NI, NL, NO, NP, NR, NT, NU, NZ, OM, PA, PE, PF, PG, PH, PK, PL, PM, PN, PR, PS, PT, PW, PY, QA, RE, RO, RS, RU, RW, SA, SB, SC, SD, SE, SF, SG, SH, SI, SJ, SK, SL, SM, SN, SO, SR, SS, ST, SU, SV, SX, SY, SZ, TA, TC, TD, TF, TG, TH, TJ, TK, TL, TM, TN, TO, TP, TR, TT, TV, TW, TZ, UA, UG, UK, UM, US, UY, UZ, VA, VC, VE, VG, VI, VN, VU, WF, WS, XI, XU, XK, YE, YT, YU, ZA, ZM, ZR, ZW]

    The 2-digit country code of the physical postal address according to ISO 3166-1.

  • administrativeAreaLevel1 string

    The 2-digit country subdivision code according to ISO 3166-2, such as a region within a country.

  • administrativeAreaLevel2 string

    The name of the locally regulated secondary country subdivision of the physical postal address, such as county within a country.

  • administrativeAreaLevel3 string

    The name of the locally regulated tertiary country subdivision of the physical address, such as townships within a country.

  • postalCode string

    The alphanumeric identifier (sometimes including spaces or punctuation) of the physical postal address for the purpose of sorting mail, synonyms:postcode, post code, PIN or ZIP code.

  • city string

    The name of the city of the physical postal address, synonyms: town, village, municipality.

  • district string

    The name of the district of the physical postal address which divides the city in several smaller areas.

  • street object

    The street of the physical postal address, synonyms: road, avenue, lane, boulevard, highway

  • namePrefix string

    The street related information, which is usually printed before the official street name on an address label.

  • additionalNamePrefix string

    The additional street related information, which is usually printed before the official street name on an address label.

  • name string

    The name of the street.

  • nameSuffix string

    The street related information, which is usually printed after the official street name on an address label.

  • additionalNameSuffix string

    The additional street related information, which is usually printed after the official street name on an address label.

  • houseNumber string

    The number representing the exact location of a building within the street.

  • houseNumberSupplement string
  • milestone string

    The number representing the exact location of an addressed object within a street without house numbers, such as within long roads.

  • direction string

    The cardinal direction describing where the exit to the location of the addressed object on large highways / motorways is located, such as Highway 101 South.

  • companyPostalCode string

    The company postal code of the physical postal address, which is sometimes required for large companies.

  • industrialZone string

    The industrial zone of the physical postal address, designating an area for industrial development, synonym: industrial area.

  • building string

    The alphanumeric identifier of the building addressed by the physical postal address.

  • floor string

    The number of a floor in the building addressed by the physical postal address, synonym: level.

  • door string

    The number of a door in the building on the respective floor addressed by the physical postal address, synonyms: room, suite.

  • taxJurisdictionCode string

    Tax jurisdiction codes are used to identify the specific jurisdiction(s) that a company belong to, particularly in bureaucratic processes such as tax returns and IRS forms.

  • alternativePostalAddress object

    An alternative postal address describes an alternative way of delivery for example if the goods are to be picked up somewhere else.

  • geographicCoordinates object

    The exact location of the physical postal address in latitude, longitude, and altitude.

  • longitude float

    Longitude coordinate

  • latitude float

    Latitude coordinate

  • altitude float

    Altitude, if applicable

  • country string

    Possible values: [UNDEFINED, AC, AD, AE, AF, AG, AI, AL, AM, AN, AO, AQ, AR, AS, AT, AU, AW, AX, AZ, BA, BB, BD, BE, BF, BG, BH, BI, BJ, BL, BM, BN, BO, BQ, BR, BS, BT, BU, BV, BW, BY, BZ, CA, CC, CD, CF, CG, CH, CI, CK, CL, CM, CN, CO, CP, CR, CS, CU, CV, CW, CX, CY, CZ, DE, DG, DJ, DK, DM, DO, DZ, EA, EC, EE, EG, EH, ER, ES, ET, EU, EZ, FI, FJ, FK, FM, FO, FR, FX, GA, GB, GD, GE, GF, GG, GH, GI, GL, GM, GN, GP, GQ, GR, GS, GT, GU, GW, GY, HK, HM, HN, HR, HT, HU, IC, ID, IE, IL, IM, IN, IO, IQ, IR, IS, IT, JE, JM, JO, JP, KE, KG, KH, KI, KM, KN, KP, KR, KW, KY, KZ, LA, LB, LC, LI, LK, LR, LS, LT, LU, LV, LY, MA, MC, MD, ME, MF, MG, MH, MK, ML, MM, MN, MO, MP, MQ, MR, MS, MT, MU, MV, MW, MX, MY, MZ, NA, NC, NE, NF, NG, NI, NL, NO, NP, NR, NT, NU, NZ, OM, PA, PE, PF, PG, PH, PK, PL, PM, PN, PR, PS, PT, PW, PY, QA, RE, RO, RS, RU, RW, SA, SB, SC, SD, SE, SF, SG, SH, SI, SJ, SK, SL, SM, SN, SO, SR, SS, ST, SU, SV, SX, SY, SZ, TA, TC, TD, TF, TG, TH, TJ, TK, TL, TM, TN, TO, TP, TR, TT, TV, TW, TZ, UA, UG, UK, UM, US, UY, UZ, VA, VC, VE, VG, VI, VN, VU, WF, WS, XI, XU, XK, YE, YT, YU, ZA, ZM, ZR, ZW]

    The 2-digit country code of the physical postal address according to ISO 3166-1.

  • administrativeAreaLevel1 string

    The 2-digit country subdivision code according to ISO 3166-2, such as a region within a country.

  • postalCode string

    The alphanumeric identifier (sometimes including spaces or punctuation) of the physical postal address for the purpose of sorting mail, synonyms:postcode, post code, PIN or ZIP code.

  • city string

    The name of the city of the physical postal address, synonyms: town, village, municipality.

  • deliveryServiceType string

    Possible values: [PO_BOX, PRIVATE_BAG, BOITE_POSTALE]

    One of the alternative postal address types: P.O. box, private bag, boite postale.

  • deliveryServiceQualifier string

    The qualifier uniquely identifying the delivery service endpoint of the alternative postal address in conjunction with the delivery service number. In some countries for example, entering a P.O. box number, postal code and city is not sufficient to uniquely identify a P.O. box, because the same P.O. box number is assigned multiple times in some cities.

  • deliveryServiceNumber string

    The number indicating the delivery service endpoint of the alternative postal address to which the delivery is to be delivered, such as a P.O. box number or a private bag number.

  • states object[]
  • validFrom date-time

    Date since when the status is/was valid.

  • validTo date-time

    Date until the status was valid, if applicable.

  • type string

    Possible values: [ACTIVE, INACTIVE]

    The type of this specified status.

  • createdAt date-time

    The date when the data record has been created.

  • updatedAt date-time

    The date when the data record has been last updated.

Loading...